Skip to content
API Documents/
/
/
Create an activation step...

Create an activation step in journey

Request

Create an activation step in a journey.

Security
TdApikeyAuth
Path
journeyIdinteger, (int64)required

Journey ID

Bodyapplication/json

parameters to configure the journey activation step

idstring[1-9][0-9]*required
typestringrequired
Value:"journeyActivationStep"
attributesobjectrequired
relationshipsobjectrequired
curl -i -X POST \
  'https://api-cdp.treasuredata.com/entities/journeys/{journeyId}/activations' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "type": "journeyActivationStep",
    "attributes": {
      "activationId": "string",
      "activationParams": {
        "name": "string",
        "description": "string",
        "allColumns": true,
        "columns": [
          {
            "column": "alias_name",
            "source": {
              "column": "real_column_name"
            }
          }
        ],
        "scheduleType": "daily",
        "scheduleOption": "string",
        "runAt": "string",
        "cron": "string",
        "timezone": "string",
        "startAt": "string",
        "endOn": "2019-08-24",
        "repeatUnit": "none",
        "repeatFrequency": 1,
        "connectionId": "string",
        "connectorConfig": {},
        "notifyOn": [
          "onSuccess"
        ],
        "emailRecipients": [
          0
        ],
        "activationTemplateId": "string",
        "nestedWorkflowProjectName": "string",
        "nestedWorkflowName": "string",
        "lockEnabled": true,
        "activationActionsEnabled": true,
        "syndicationBehavior": {
          "columns": [
            {
              "column": "alias_name",
              "source": {
                "column": "real_column_name"
              }
            }
          ],
          "behaviorTableName": "purchase_history",
          "joinRow": 3,
          "joinStrategy": "Last",
          "formatting": "rows",
          "orderBy": [
            {
              "key": "purchased_at",
              "order": "descending"
            },
            {
              "key": "price",
              "order": "ascending"
            }
          ]
        },
        "syndicationBehaviors": [
          {
            "columns": [
              {
                "column": "alias_name",
                "source": {
                  "column": "real_column_name"
                }
              }
            ],
            "behaviorTableName": "purchase_history",
            "joinRow": 3,
            "joinStrategy": "Last",
            "formatting": "rows",
            "orderBy": [
              {
                "key": "purchased_at",
                "order": "descending"
              },
              {
                "key": "price",
                "order": "ascending"
              }
            ]
          }
        ]
      }
    },
    "relationships": {
      "createdBy": {
        "data": {
          "id": "string",
          "type": "user"
        }
      },
      "updatedBy": {
        "data": {
          "id": "string",
          "type": "user"
        }
      }
    }
  }'

Responses

Returns a summary of the activation step in the journey

Bodyapplication/json
dataobject(JourneyActivationStepJsonApiResource)required
includedArray of objects(UserJsonApiResource)required
Response
{
  "data": {
    "id": "string",
    "type": "journeyActivationStep",
    "attributes": { … },
    "relationships": { … }
  },
  "included": [
    { … }
  ]
}